// --------------------------------------------------------------------------------------------------------------------
// <copyright file="DataCacheEventArgs.cs" company="Open Trader">
//   Copyright (c) David Denis (david.denis@systemathics.com)
// </copyright>
// <summary>
//   |  Open Trader - The Open Source Systematic Trading Platform
//   |
//   |  This program is free software: you can redistribute it and/or modify
//   |  it under the terms of the GNU General Public License as published by
//   |  the Free Software Foundation, either version 2 of the License, or
//   |  (at your option) any later version.
//   |
//   |  This program is distributed in the hope that it will be useful,
//   |  but WITHOUT ANY WARRANTY; without even the implied warranty of
//   |  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//   |  GNU General Public License for more details.
//   |
//   |  You should have received a copy of the GNU General Public License
//   |  along with this program.  If not, see http://www.gnu.org/licenses
//   |
//   |  Up to date informations about Open Trader can be found at :
//   |    http://opentrader.org
//   |    http://opentrader.codeplex.com
//   |
//   |  For professional services, please visit us at :
//   |    http://www.systemathics.com
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace Org.OpenTrader.Framework.Forge.Events
{
    #region Using Directives

    using System;

    using Org.OpenTrader.Framework.Events;
    using Org.OpenTrader.Framework.Forge.Enums;

    #endregion

    /// <summary>
    /// The data cache event args.
    /// </summary>
    [Serializable]
    public abstract class DataCacheEventArgs : AbstractEventArgs
    {
        /// <summary>
        /// The cache modified.
        /// </summary>
        [Serializable]
        public class CacheModified : DataCacheEventArgs
        {
            #region Constructors and Destructors

            /// <summary>
            /// Initializes a new instance of the <see cref="CacheModified"/> class.
            /// </summary>
            /// <param name="action">
            /// The action.
            /// </param>
            /// <param name="element">
            /// The element.
            /// </param>
            /// <param name="objectID">
            /// The object id.
            /// </param>
            public CacheModified(EDataCacheAction action, EDataCacheElement element, Guid objectID)
            {
                this.Action = action;
                this.Element = element;
                this.ID = objectID;
            }

            #endregion

            #region Properties

            /// <summary>
            /// Gets Action.
            /// </summary>
            public EDataCacheAction Action { get; private set; }

            /// <summary>
            /// Gets Element.
            /// </summary>
            public EDataCacheElement Element { get; private set; }

            /// <summary>
            /// Gets ID.
            /// </summary>
            public Guid ID { get; private set; }

            #endregion

            #region Public Methods

            /// <summary>
            /// The to string.
            /// </summary>
            /// <returns>
            /// The to string.
            /// </returns>
            public override string ToString()
            {
                return string.Format("CacheModified[Action={0};Element={1};ID={2}]", this.Action, this.Element, this.ID);
            }

            #endregion
        }
    }
}